<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.command;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.List;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    public interface CommandMap {<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>        /**<a name="line.7"></a>
<FONT color="green">008</FONT>         * Registers all the commands belonging to a certain plugin.<a name="line.8"></a>
<FONT color="green">009</FONT>         * Caller can use:-<a name="line.9"></a>
<FONT color="green">010</FONT>         * command.getName() to determine the label registered for this command<a name="line.10"></a>
<FONT color="green">011</FONT>         * command.getAliases() to determine the aliases which where registered<a name="line.11"></a>
<FONT color="green">012</FONT>         *<a name="line.12"></a>
<FONT color="green">013</FONT>         * @param fallbackPrefix a prefix which is prepended to each command with a ':' one or more times to make the command unique<a name="line.13"></a>
<FONT color="green">014</FONT>         * @param commands a list of commands to register<a name="line.14"></a>
<FONT color="green">015</FONT>         */<a name="line.15"></a>
<FONT color="green">016</FONT>        public void registerAll(String fallbackPrefix, List&lt;Command&gt; commands);<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>        /**<a name="line.18"></a>
<FONT color="green">019</FONT>         * Registers a command. Returns true on success; false if name is already taken and fallback had to be used.<a name="line.19"></a>
<FONT color="green">020</FONT>         * Caller can use:-<a name="line.20"></a>
<FONT color="green">021</FONT>         * command.getName() to determine the label registered for this command<a name="line.21"></a>
<FONT color="green">022</FONT>         * command.getAliases() to determine the aliases which where registered<a name="line.22"></a>
<FONT color="green">023</FONT>         *<a name="line.23"></a>
<FONT color="green">024</FONT>         * @param label the label of the command, without the '/'-prefix.<a name="line.24"></a>
<FONT color="green">025</FONT>         * @param fallbackPrefix a prefix which is prepended to the command with a ':' one or more times to make the command unique<a name="line.25"></a>
<FONT color="green">026</FONT>         * @param command the command to register<a name="line.26"></a>
<FONT color="green">027</FONT>         * @return true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times<a name="line.27"></a>
<FONT color="green">028</FONT>         */<a name="line.28"></a>
<FONT color="green">029</FONT>        public boolean register(String label, String fallbackPrefix, Command command);<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>        /**<a name="line.31"></a>
<FONT color="green">032</FONT>         * Registers a command. Returns true on success; false if name is already taken and fallback had to be used.<a name="line.32"></a>
<FONT color="green">033</FONT>         * Caller can use:-<a name="line.33"></a>
<FONT color="green">034</FONT>         * command.getName() to determine the label registered for this command<a name="line.34"></a>
<FONT color="green">035</FONT>         * command.getAliases() to determine the aliases which where registered<a name="line.35"></a>
<FONT color="green">036</FONT>         *<a name="line.36"></a>
<FONT color="green">037</FONT>         * @param fallbackPrefix a prefix which is prepended to the command with a ':' one or more times to make the command unique<a name="line.37"></a>
<FONT color="green">038</FONT>         * @param command the command to register, from which label is determined from the command name<a name="line.38"></a>
<FONT color="green">039</FONT>         * @return true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times<a name="line.39"></a>
<FONT color="green">040</FONT>         */<a name="line.40"></a>
<FONT color="green">041</FONT>        public boolean register(String fallbackPrefix, Command command);<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * Looks for the requested command and executes it if found.<a name="line.44"></a>
<FONT color="green">045</FONT>         *<a name="line.45"></a>
<FONT color="green">046</FONT>         * @param cmdLine command + arguments. Example: "/test abc 123"<a name="line.46"></a>
<FONT color="green">047</FONT>         * @return targetFound returns false if no target is found, true otherwise.<a name="line.47"></a>
<FONT color="green">048</FONT>         * @throws CommandException Thrown when the executor for the given command fails with an unhandled exception<a name="line.48"></a>
<FONT color="green">049</FONT>         */<a name="line.49"></a>
<FONT color="green">050</FONT>        public boolean dispatch(CommandSender sender, String cmdLine) throws CommandException;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Clears all registered commands.<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        public void clearCommands();<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /**<a name="line.57"></a>
<FONT color="green">058</FONT>         * Gets the command registered to the specified name<a name="line.58"></a>
<FONT color="green">059</FONT>         *<a name="line.59"></a>
<FONT color="green">060</FONT>         * @param name Name of the command to retrieve<a name="line.60"></a>
<FONT color="green">061</FONT>         * @return Command with the specified name or null if a command with that label doesn't exist<a name="line.61"></a>
<FONT color="green">062</FONT>         */<a name="line.62"></a>
<FONT color="green">063</FONT>        public Command getCommand(String name);<a name="line.63"></a>
<FONT color="green">064</FONT>    }<a name="line.64"></a>




























































</PRE>
</BODY>
</HTML>
